home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Amiga Format CD 23
/
Amiga Format AFCD23 (Feb 1998, Issue 107).iso
/
-seriously_amiga-
/
shareware
/
programming
/
mui
/
mcc_monthnavigator
/
developer
/
autodocs
/
mcc_monthnavigator.doc
Wrap
Text File
|
1997-12-06
|
19KB
|
690 lines
TABLE OF CONTENTS
MonthNavigator/--background--
MonthNavigator/MUIA_MonthNavigator_Draggable
MonthNavigator/MUIA_MonthNavigator_DragDropHook
MonthNavigator/MUIA_MonthNavigator_DragQueryHook
MonthNavigator/MUIA_MonthNavigator_Dropable
MonthNavigator/MUIA_MonthNavigator_InputMode
MonthNavigator/MUIA_MonthNavigator_LineWeekdayNames
MonthNavigator/MUIA_MonthNavigator_LineWeekNumbers
MonthNavigator/MUIA_MonthNavigator_MarkHook
MonthNavigator/MUIA_MonthNavigator_MonthAdjust
MonthNavigator/MUIA_MonthNavigator_ShowInvisibles
MonthNavigator/MUIA_MonthNavigator_ShowLastMonthDays
MonthNavigator/MUIA_MonthNavigator_ShowNextMonthDays
MonthNavigator/MUIA_MonthNavigator_ShowWeekNumbers
MonthNavigator/MUIA_MonthNavigator_ShowWeekdayNames
MonthNavigator/MUIA_MonthNavigator_UseFrames
MonthNavigator/MUIA_MonthNavigator_WeekNumbersSpacing
MonthNavigator/MUIA_MonthNavigator_WeekdayNamesSpacing
MonthNavigator/MUIM_MonthNavigator_DragDrop
MonthNavigator/MUIM_MonthNavigator_DragQuery
MonthNavigator/MUIM_MonthNavigator_Mark
MonthNavigator/MUIM_MonthNavigator_Update
MonthNavigator/--background--
NAME
MonthNavigator -- Month based navigator through time (V16)
FUNCTION
MonthNavigator is a Custom Class of the Magic User Interface © by
Stefan Stuntz.
It is a subclass of group-class.
The idea of this class was born during developing my Gregor
application.
MUI public custom class showing a field with the days of a specified
month in a specified year.
The user decides if the names of the weekdays and the weeknumbers
will be shown. Also it is possible for the user to set which weekday
should be the day on which a week was started - the language for the
weekday names can also be chosen.
A special feature of this class is, that it correctly handles
October 1582. In this month the days 5-14 didn't exist, because they
were removed by the Gregorian calendar reform. This calendar reform
happens in different years for different countries, so the user can
set his country with the user preferences.
NOTES
None at the moment.
MonthNavigator/MUIA_MonthNavigator_Draggable
NAME
MUIA_MonthNavigator_Draggable, BOOL [ISG] -- ... (V16.0)
SYNOPSIS
MUIA_MonthNavigator_Draggable, draggable,
/*result =*/ set(obj,MUIA_MonthNavigator_Draggable,draggable);
/*result =*/ get(obj,MUIA_MonthNavigator_Draggable,&draggable);
FUNCTION
With MUIA_MonthNavigator_Draggable you can define that the
days of a MonthNavigator object are draggable.
Defaults to: FALSE
INPUTS
draggable - TRUE : Days can be dragged
FALSE: No drag of days
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MonthNavigator/MUIA_MonthNavigator_DragDropHook
NAME
MUIA_MonthNavigator_DragDropHook, struct Hook * [IS.] -- ... (V16.3)
(OBSOLETE)
SYNOPSIS
MUIA_MonthNavigator_DragDropHook, &hook,
/*result =*/ set(obj,MUIA_MonthNavigator_DragDropHook,&hook);
FUNCTION
With MUIA_MonthNavigator_DragDropHook you define a hook function
that will be called when something was dropped on a day.
Defaults to: NULL
INPUTS
hook - Pointer to a hook structure.
NOTES
The hook function has the following structure:
ULONG __saveds __asm DragDropFkt(register __a0 struct Hook *hook,
register __a1 Object *obj,
register __a2 struct MUIS_MonthNavigator_MarkDay *day)
{
/* do something with the object */
/* mark the day if needed */
return(TRUE); /* changed day contents */
return(FALSE); /* day contents is unchanged */
}
You are *NOT* allowed to manipulate Version, Year, Month or Day!
All other settings are predefined with the actual content. See
MUIA_MonthNavigator_MarkHook for more.
BUGS
No known bugs.
SEE ALSO
MUIM_MonthNavigator_DragDrop, MUIA_MonthNavigator_DragQueryHook,
MUIA_MonthNavigator_MarkHook, MUIA_MonthNavigator_Dropable,
MUI_Area.doc/MUIM_DragDrop
MonthNavigator/MUIA_MonthNavigator_DragQueryHook
NAME
MUIA_MonthNavigator_DragQueryHook, struct Hook * [IS.] -- ... (V16.3)
(OBSOLETE)
SYNOPSIS
MUIA_MonthNavigator_DragQueryHook, &hook,
/*result =*/ set(obj,MUIA_MonthNavigator_DragQueryHook,&hook);
FUNCTION
With MUIA_MonthNavigator_DragQueryHook you define a hook function
that will be called when something should be dropped on a day.
Defaults to: NULL
INPUTS
hook - Pointer to a hook structure.
NOTES
The hook function has the following structure:
ULONG __saveds __asm DragQueryFkt(register __a0 struct Hook *hook,
register __a1 Object *obj,
register __a2 struct MUIS_MonthNavigator_MarkDay *day)
{
/* return(MUIV_DragQuery_Accept); when the object is supported */
/* return(MUIV_DragQuery_Refuse); otherwise */
}
You are *NOT* allowed to manipulate Version, Year, Month or Day!
All other settings are predefined with the actual content. See
MUIA_MonthNavigator_MarkHook for more.
BUGS
No known bugs.
SEE ALSO
MUIM_MonthNavigator_DragQuery, MUIA_MonthNavigator_DragDropHook,
MUIA_MonthNavigator_MarkHook, MUIA_MonthNavigator_Dropable,
MUI_Area.doc/MUIM_DragQuery
MonthNavigator/MUIA_MonthNavigator_Dropable
NAME
MUIA_MonthNavigator_Dropable, BOOL [ISG] -- ... (V16.3)
SYNOPSIS
MUIA_MonthNavigator_Dropable, dropable,
/*result =*/ set(obj,MUIA_MonthNavigator_Dropable,dropable);
/*result =*/ get(obj,MUIA_MonthNavigator_Dropable,&dropable);
FUNCTION
With MUIA_MonthNavigator_Dropable you can define that objects can be
dropped onto the days of a MonthNavigator object.
Defaults to: FALSE
INPUTS
dropable - TRUE : Objects can be dropped onto days
FALSE: Objects can not be dropped onto days
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIM_MonthNavigator_DragQuery, MUIM_MonthNavigator_DragDrop,
MUI_Area.doc/MUIM_Dropable
MonthNavigator/MUIA_MonthNavigator_InputMode
NAME
MUIA_MonthNavigator_InputMode, ULONG [I..] -- ... (V12.2)
SYNOPSIS
MUIA_MonthNavigator_InputMode, inputmode,
FUNCTION
With MUIA_MonthNavigator_InputMode you can define that the
MonthNavigator object is a read only or an input object. Input means
that the user can press buttons.
Defaults to: MUIV_MonthNavigator_InputMode_None
INPUTS
inputmode - MUIV_MonthNavigator_InputMode_None:
Results in a read-only object
MUIV_MonthNavigator_InputMode_RelVerify:
Usefull if the object is used for inserting dates
MUIV_MonthNavigator_InputMode_Immediate:
Usefull if the object is used for selecting dates
See Area.mui/MUIA_InputMode for more.
NOTES
None
BUGS
No known bugs.
SEE ALSO
MCC_Date.doc/MUIA_Date_Day, MUIA_MonthNavigator_UseFrames
MonthNavigator/MUIA_MonthNavigator_LineWeekdayNames
NAME
MUIA_MonthNavigator_LineWeekdayNames, BOOL [I..] -- ... (V12.3)
SYNOPSIS
MUIA_MonthNavigator_LineWeekdayNames, lwn,
FUNCTION
The MUIA_MonthNavigator_LineWeekdayNames attribute defines that a
line will be drawn between the names of the weekdays and the
day-field.
Defaults to FALSE
INPUTS
lwn - TRUE : Draw line
FALSE : Do not draw a line
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_WeekdayNamesSpacing,
MUIA_MonthNavigator_ShowWeekdayNames,
MUIA_MonthNavigator_LineWeekNumbers
MonthNavigator/MUIA_MonthNavigator_LineWeekNumbers
NAME
MUIA_MonthNavigator_LineWeekNumbers, BOOL [I..] -- ... (V12.3)
SYNOPSIS
MUIA_MonthNavigator_LineWeekNumbers, lwn,
FUNCTION
The MUIA_MonthNavigator_LineWeekNumbers attribute defines that a
line will be drawn between the weeknumbers and the day-field.
Defaults to FALSE
INPUTS
lwn - TRUE : Draw a line
FALSE : Do not draw a line
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_WeekNumbersSpacing,
MUIA_MonthNavigator_ShowWeekNumbers,
MUIA_MonthNavigator_LineWeekdayNames
MonthNavigator/MUIA_MonthNavigator_MarkHook
NAME
MUIA_MonthNavigator_MarkHook, struct Hook * [IS.] -- ... (V16.2)
(OBSOLETE)
SYNOPSIS
MUIA_MonthNavigator_MarkHook, &hook,
/*result =*/ set(obj,MUIA_MonthNavigator_MarkHook,&hook);
FUNCTION
With MUIA_MonthNavigator_MarkHook you define a hook function
that can mark a day by changing the PreParse or/and Background
settings.
Defaults to: NULL
INPUTS
hook - Pointer to a hook structure.
Builtin mark hooks:
MUIV_MonthNavigator_MarkHook_HiToday : highlight today
NOTES
The hook function has the following structure:
ULONG __saveds __asm MarkFkt(register __a0 struct Hook *hook,
register __a2 struct MUIS_MonthNavigator_MarkDay *markday)
{
if ((markday->Year >= 1970) && (markday->Month == 9) &&
(markday->Day == 18))
{
markday->PreParse = "\033n\0338\033c";
return(TRUE); /* changed markday contents */
}
else
{
return(FALSE); /* markday contents is unchanged */
}
}
You are *NOT* allowed to manipulate Version, Year, Month or Day!
Background is predefined with MUII_ButtonBack or MUII_TextBack,
depending on the InputMode.
PreParse is predefined with "\033n\0332\033c".
ShortHelp is predefined with NULL.
Disabled is predefined with FALSE.
BUGS
No known bugs.
SEE ALSO
MUIM_MonthNavigator_Mark
MonthNavigator/MUIA_MonthNavigator_MonthAdjust
NAME
MUIA_MonthNavigator_MonthAdjust, WORD [..G] -- ... (V16.5)
SYNOPSIS
MUIA_MonthNavigator_MonthAdjust, 1,
FUNCTION
The MUIA_MonthNavigator_MonthAdjust attribute of a MonthNavigator
day-button is used for the days of the previous/next month.
INPUTS
adjust - 0 : Actual month
-1 : Previous month
1 : Following month
NOTES
This attribute can be used from within the following methods only:
MUIM_MonthNavigator_Mark, MUIM_MonthNavigator_DragQuery,
MUIM_MonthNavigator_DragDrop
BUGS
No known bugs.
SEE ALSO
MUIM_MonthNavigator_Mark, MUIM_MonthNavigator_DragQuery,
MUIM_MonthNavigator_DragDrop
MonthNavigator/MUIA_MonthNavigator_ShowInvisibles
NAME
MUIA_MonthNavigator_ShowInvisibles, BOOL [I..] -- ... (V12.1)
SYNOPSIS
MUIA_MonthNavigator_ShowInvisibles, FALSE,
FUNCTION
Setting the MUIA_MonthNavigator_ShowInvisibles attribute to TRUE
makes the empty fields in the first and the last line visible
Defaults to FALSE
INPUTS
bool - TRUE : Show invisible fields
FALSE: Hide invisible fields
NOTES
Keep in mind that this tag will overwrite the user prefs!
Invisible fields will not be shown if you switch off frames and
set the object to be a read-only one.
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_UseFrames
MonthNavigator/MUIA_MonthNavigator_ShowLastMonthDays
NAME
MUIA_MonthNavigator_ShowLastMonthDays, BOOL [I..] -- ... (V16.4)
SYNOPSIS
MUIA_MonthNavigator_ShowLastMonthDays, FALSE,
FUNCTION
Setting the MUIA_MonthNavigator_ShowLastMonthDays attribute to TRUE
makes the empty fields in the first line showing the last days from
the previous month.
Defaults to FALSE
INPUTS
bool - TRUE : Show last days of previous month.
FALSE: Show empty fields.
NOTES
Keep in mind that this tag will overwrite the user prefs!
The days of the previous month will only be shown in ImmediateMode.
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_ShowNextMonthDays
MonthNavigator/MUIA_MonthNavigator_ShowNextMonthDays
NAME
MUIA_MonthNavigator_ShowNextMonthDays, BOOL [I..] -- ... (V16.4)
SYNOPSIS
MUIA_MonthNavigator_ShowNextMonthDays, FALSE,
FUNCTION
Setting the MUIA_MonthNavigator_ShowNextMonthDays attribute to TRUE
makes the empty fields in the last line showing the first days from
the following month.
Defaults to FALSE
INPUTS
bool - TRUE : Show first days of following month.
FALSE: Show empty fields.
NOTES
Keep in mind that this tag will overwrite the user prefs!
The days of the following month will only be shown in ImmediateMode.
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_ShowLastMonthDays
MonthNavigator/MUIA_MonthNavigator_ShowWeekNumbers
NAME
MUIA_MonthNavigator_ShowWeekNumbers, BOOL [I..] -- ... (V12)
SYNOPSIS
MUIA_MonthNavigator_ShowWeekNumbers, FALSE,
FUNCTION
Setting the MUIA_MonthNavigator_ShowWeekNumbers attribute to FALSE
hides the week numbers.
Defaults to TRUE
INPUTS
bool - TRUE : Show weeknumbers
FALSE: Don't show weeknumbers
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_ShowWeekdayNames, MUIA_MonthNavigator_UseFrames
MonthNavigator/MUIA_MonthNavigator_ShowWeekdayNames
NAME
MUIA_MonthNavigator_ShowWeekdayNames, BOOL [I..] -- ... (V12)
SYNOPSIS
MUIA_MonthNavigator_ShowWeekdayNames, FALSE,
FUNCTION
Setting the MUIA_MonthNavigator_ShowWeekdayNames attribute to FALSE
hides the weekday names.
Defaults to TRUE
INPUTS
bool - TRUE : Show weekday names
FALSE: Don't show weekday names
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MCC_Date.doc/MUIA_Date_FirstWeekday, MCC_Date.doc/MUIA_Date_Language,
MUIA_MonthNavigator_ShowWeekNumbers, MUIA_MonthNavigator_UseFrames
MonthNavigator/MUIA_MonthNavigator_UseFrames
NAME
MUIA_MonthNavigator_UseFrames, BOOL [I..] -- ... (V12.1)
SYNOPSIS
MUIA_MonthNavigator_UseFrames, useframes,
FUNCTION
With MUIA_MonthNavigator_UseFrames you can define that the
MonthNavigator object uses frames (and backgrounds) for the names of
weekdays, the weeknumbers and in read-only mode for the
day-buttons.
Defaults to: TRUE
INPUTS
useframes - TRUE : Display with frames
FALSE: Display without frames
NOTES
Keep in mind that this tag will overwrite the user prefs!
Setting this attribute to FALSE only works when the object is in
read-only mode, because MUI only supports PhantomFrames for
horizontal usage.
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_InputMode, MUIA_MonthNavigator_ShowWeekNumbers,
MUIA_MonthNavigator_ShowWeekdayNames,
MUIA_MonthNavigator_ShowInvisibles
MonthNavigator/MUIA_MonthNavigator_WeekNumbersSpacing
NAME
MUIA_MonthNavigator_WeekNumbersSpacing, ULONG [I..] -- ... (V12.3)
SYNOPSIS
MUIA_MonthNavigator_WeekNumbersSpacing, spacing,
FUNCTION
The MUIA_MonthNavigator_WeekNumbersSpacing attribute defines the
space that will be used between the numbers of weeks and the
day-field.
Defaults to 8
INPUTS
spacing - Pixels that should be used (1-18)
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_WeekdayNamesSpacing,
MUIA_MonthNavigator_ShowWeekNumbers,
MUIA_MonthNavigator_LineWeekNumbers
MonthNavigator/MUIA_MonthNavigator_WeekdayNamesSpacing
NAME
MUIA_MonthNavigator_WeekdayNamesSpacing, ULONG [I..] -- ... (V12.3)
SYNOPSIS
MUIA_MonthNavigator_WeekdayNamesSpacing, spacing,
FUNCTION
The MUIA_MonthNavigator_WeekdayNamesSpacing attribute defines the
space that will be used between the names of the weekdays and the
day-field.
Defaults to 8
INPUTS
spacing - Pixels that should be used (1-18)
NOTES
Keep in mind that this tag will overwrite the user prefs!
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_WeekNumbersSpacing,
MUIA_MonthNavigator_ShowWeekdayNames,
MUIA_MonthNavigator_LineWeekdayNames
MonthNavigator/MUIM_MonthNavigator_DragDrop
NAME
MUIM_MonthNavigator_DragDrop -- DragDrop for day-buttons (V16.5)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_MonthNavigator_DragDrop,obj,dayobj,
Year,Month,Day);
FUNCTION
This method is equivalent to MUI's DragDrop method, except that it
will be used for the day-buttons instead of the MonthNavigator
object.
This method will be called when something was dropped on a day.
The default implementation calls the
MUIA_MonthNavigator_DragDropHook for backward compatibility.
INPUTS
obj - Dropped object
dayobj - Day object onto which the object was dropped
Year, Month, Day - Date to drop on
NOTES
You can change the following attributes of the day object:
Background, PreParse, ShortHelp, Disabled
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_DragDropHook, MUI_Area.doc/MUIM_DragDrop
MonthNavigator/MUIM_MonthNavigator_DragQuery
NAME
MUIM_MonthNavigator_DragQuery -- DragQuery for day-buttons (V16.5)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_MonthNavigator_DragQuery,obj,dayobj,
Year,Month,Day);
FUNCTION
This method is equivalent to MUI's DragQuery method, except that it
will be used for the day-buttons instead of the MonthNavigator
object.
This method will be called when something should be dropped on a day.
The default implementation calls the
MUIA_MonthNavigator_DragQueryHook for backward compatibility.
INPUTS
obj - Object to be dropped
dayobj - Day object onto which the object should be dropped
Year, Month, Day - Date to query
NOTES
None.
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_DragQueryHook, MUI_Area.doc/MUIM_DragQuery
MonthNavigator/MUIM_MonthNavigator_Mark
NAME
MUIM_MonthNavigator_Mark -- Method for marking a date (V16.5)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_MonthNavigator_Mark,dayobj,Year,Month,
Day);
FUNCTION
This method will be called for every day button when an update
happens. This will allow to mark a date by changing the day objects
settings.
The default implementation calls the MUIA_MonthNavigator_MarkHook
to be backward comptible.
INPUTS
dayobj - Day button/text object
Year, Month, Day - Date to mark
NOTES
You can change the following attributes of the day object:
Background, PreParse, ShortHelp, Disabled
BUGS
No known bugs.
SEE ALSO
MUIA_MonthNavigator_MarkHook
MonthNavigator/MUIM_MonthNavigator_Update
NAME
MUIM_MonthNavigator_Update -- Update the display (V12)
SYNOPSIS
\*result =*\ DoMethod(obj,MUIM_MonthNavigator_Update);
FUNCTION
Updates the display after month and/or year have changed.
This method is also used after object creation.
NOTES
This method is used internally, and normally you should have *no*
reason to use it! The only time it makes sense to use this method
is after loading calendar data from disk to update the markings,
or at 00:00:00 to highlight the new 'today'.
BUGS
No known bugs.
SEE ALSO
MCC_Date.doc/MUIA_Date_Month, MCC_Date.doc/MUIA_Date_Year